home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmClipboardLock.z / XmClipboardLock
Encoding:
Text File  |  2003-11-18  |  4.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k - A clipboard    function that locks the
  10.       clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Xm/Xm.h>
  14.       #include <Xm/CutPaste.h>
  15.  
  16.       int _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k (ddddiiiissssppppllllaaaayyyy,,,,    wwwwiiiinnnnddddoooowwww)
  17.            _D_i_s_p_l_a_y     **** ddddiiiissssppppllllaaaayyyy;
  18.            _W_i_n_d_o_w     wwwwiiiinnnnddddoooowwww;
  19.  
  20.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.       _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k locks    the clipboard from access by another
  22.       application until _X_m_C_l_i_p_b_o_a_r_d_U_n_l_o_c_k is called.  All
  23.       clipboard functions lock and unlock the clipboard to prevent
  24.       simultaneous access.    This function allows the application
  25.       to keep the clipboard    data from changing between calls to
  26.       _I_n_q_u_i_r_e and other clipboard functions.  The application does
  27.       not need to lock the clipboard between calls to
  28.       _X_m_C_l_i_p_b_o_a_r_d_S_t_a_r_t_C_o_p_y and _X_m_C_l_i_p_b_o_a_r_d_E_n_d_C_o_p_y or to
  29.       _X_m_C_l_i_p_b_o_a_r_d_S_t_a_r_t_R_e_t_r_i_e_v_e and _X_m_C_l_i_p_b_o_a_r_d_E_n_d_R_e_t_r_i_e_v_e.
  30.  
  31.       If the clipboard is already locked by    another    application,
  32.       _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k returns an error status.  Multiple calls to
  33.       this function    by the same application    increases the lock
  34.       level.
  35.  
  36.       ddddiiiissssppppllllaaaayyyy
  37.            Specifies a pointer to the _D_i_s_p_l_a_y structure that was
  38.            returned    in a previous call to _X_O_p_e_n_D_i_s_p_l_a_y or
  39.            _X_t_D_i_s_p_l_a_y.
  40.  
  41.       wwwwiiiinnnnddddoooowwww
  42.            Specifies a widget's window ID that relates the
  43.            application window to the clipboard.  The widget's
  44.            window ID can be    obtained by using _X_t_W_i_n_d_o_w.  The same
  45.            application instance should pass    the same window    ID to
  46.            each of the clipboard functions that it calls.
  47.  
  48.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  49.       _C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  50.            The function is successful.
  51.  
  52.       _C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  53.            The function failed because the clipboard was locked by
  54.            another application.  The application can continue to
  55.            call the    function again with the    same parameters    until
  56.            the lock    goes away.  This gives the application the
  57.            opportunity to ask if the user wants to keep trying or
  58.            to give up on the operation.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  75.       _X_m_C_l_i_p_b_o_a_r_d_E_n_d_C_o_p_y(_3_X), _X_m_C_l_i_p_b_o_a_r_d_E_n_d_R_e_t_r_i_e_v_e(_3_X),
  76.       _X_m_C_l_i_p_b_o_a_r_d_S_t_a_r_t_C_o_p_y(_3_X), _X_m_C_l_i_p_b_o_a_r_d_S_t_a_r_t_R_e_t_r_i_e_v_e(_3_X), and
  77.       _X_m_C_l_i_p_b_o_a_r_d_U_n_l_o_c_k(_3_X).
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.